home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / network / pcmenu30.zip / PCMENU30.TXT < prev    next >
Text File  |  1993-09-06  |  68KB  |  1,848 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                         PcMenu
  16.  
  17.                                      Version 3.0
  18.  
  19.                                      User Manual
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.             Brian Habel   1993
  45.  
  46.  
  47.    Table of Contents
  48.  
  49.    Legal Stuff
  50.         Grant of Rights  . . . . . . . . . . . . . . . . . . . . . . .    1
  51.         Restrictions . . . . . . . . . . . . . . . . . . . . . . . . .    1
  52.         Limitations of Liability . . . . . . . . . . . . . . . . . . .    1
  53.         Redistribution . . . . . . . . . . . . . . . . . . . . . . . .    1
  54.         Registration . . . . . . . . . . . . . . . . . . . . . . . . .    2
  55.         Credits  . . . . . . . . . . . . . . . . . . . . . . . . . . .    2
  56.         Contacting the Author  . . . . . . . . . . . . . . . . . . . .    2
  57.  
  58.    Introduction
  59.         What is PcMenu . . . . . . . . . . . . . . . . . . . . . . . .    3
  60.  
  61.    Installation of PcMenu
  62.         System Requirements  . . . . . . . . . . . . . . . . . . . . .    4
  63.         Copying the files to your System . . . . . . . . . . . . . . .    4
  64.              Installation on a standalone PC . . . . . . . . . . . . .    4
  65.         How it all works . . . . . . . . . . . . . . . . . . . . . . .    5
  66.         Upgrading from PcMenu Version 2.1  . . . . . . . . . . . . . .    6
  67.         Implementation . . . . . . . . . . . . . . . . . . . . . . . .    6
  68.         Setting up the INI file  . . . . . . . . . . . . . . . . . . .    8
  69.              INI File Options  . . . . . . . . . . . . . . . . . . . .    8
  70.                   MENU_BATCH . . . . . . . . . . . . . . . . . . . . .    8
  71.                   BATCH_FILENAME . . . . . . . . . . . . . . . . . . .    9
  72.                   INFO_BOX_UPDATE  . . . . . . . . . . . . . . . . . .    9
  73.                   SCREEN_SAVER . . . . . . . . . . . . . . . . . . . .    9
  74.                   ALPHA_KEYING . . . . . . . . . . . . . . . . . . . .   10
  75.                   TABS . . . . . . . . . . . . . . . . . . . . . . . .   10
  76.                   HELP_BAR_COLOURS . . . . . . . . . . . . . . . . . .   10
  77.                   SAVER_MESSAGES . . . . . . . . . . . . . . . . . . .   10
  78.                   SCREEN_SAVER_MESSAGE . . . . . . . . . . . . . . . .   10
  79.  
  80.    How To Use PcMenu
  81.         Planning Your Menus  . . . . . . . . . . . . . . . . . . . . .   11
  82.         Defining Your Menus  . . . . . . . . . . . . . . . . . . . . .   11
  83.         Option Hiding  . . . . . . . . . . . . . . . . . . . . . . . .   13
  84.         Alternate Sub Menu Files . . . . . . . . . . . . . . . . . . .   15
  85.         Locating Your Menus On The Screen  . . . . . . . . . . . . . .   15
  86.         Using Your Mouse With PcMenu . . . . . . . . . . . . . . . . .   16
  87.         More On Batch File Programming . . . . . . . . . . . . . . . .   17
  88.         PcMenu's Information Box . . . . . . . . . . . . . . . . . . .   19
  89.  
  90.    The PalDef Colour Program
  91.         How To Colour Your Menus . . . . . . . . . . . . . . . . . . .   22
  92.  
  93.    Appendix A
  94.         Compatibility between Version 3.0 and Version 2.1  . . . . . .   24
  95.  
  96.    Appendix B
  97.         Amendments and Additions to PcMenu Version 2.1 . . . . . . . .   25
  98.  
  99.    PcMenu Version 3.0 User Manual                                     Page ii
  100.  
  101.    Appendix C
  102.         The format of the initialisation file & use with NetWare . . .   27
  103.              PCMENU.BAT  . . . . . . . . . . . . . . . . . . . . . . .   27
  104.              PCMU$INI.DAT  . . . . . . . . . . . . . . . . . . . . . .   28
  105.  
  106.    Appendix D
  107.         Registration Form  . . . . . . . . . . . . . . . . . . . . . .   31
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.    PcMenu Version 3.0 User Manual                                    Page iii
  155.  
  156.    Legal Stuff
  157.  
  158.    Grant of Rights
  159.  
  160.    PcMenu and PalDef are Copyright    1989, 1990, 1991, 1992, 1993 by Brian
  161.    Habel.
  162.  
  163.    Although  subject to  copyright,  this is  FREE  software providing  the
  164.    restrictions below are adhered too.
  165.  
  166.    THE USE OF THIS SOFTWARE INDICATES YOUR ACCEPTANCE OF THE TERMS OUTLINED
  167.    BELOW !
  168.  
  169.    Restrictions
  170.    You may not sell this software.
  171.  
  172.    You may use this software anywhere any place where NO personal financial
  173.    gain is procured as a direct result of its use.
  174.  
  175.    Limitations of Liability
  176.    This  software  is distributed  AS  IS, and  the author  cannot  be held
  177.    responsible, and  will not be  liable to you for  damages, including any
  178.    loss  of profits,  lost  savings, or  other incidental  or consequential
  179.    damages arising out of your use of this software, even if the author has
  180.    been advised of the possibility of such damage.
  181.  
  182.    Redistribution
  183.    You  may (  and are indeed  encouraged to  ) redistribute  this software
  184.    providing that, No Profit is attained,  and, that this notice and all of
  185.    its  accompanying  material,  including  all  files  and  programs,  are
  186.    distributed together, whether  it be  by electronic  media, or  Bulletin
  187.    Board Service.
  188.  
  189.    NOTICE
  190.    NOVELL  and NETWARE  are registered  trademarks of  Novell Inc.,  Provo,
  191.    Utah, USA.
  192.    WordPerfect is a registered trademark of the WordPerfect Corporation  in
  193.    USA, UK, and in other countries.
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.    PcMenu Version 3.0 User Manual                                      Page 1
  210.  
  211.  
  212.    Registration
  213.    If  you use this software either in your place of employment, or on your
  214.    home PC, the Author would like to know.   At the back of this User Guide
  215.    you  will find a  Registration Form asking a  few simple questions about
  216.    how and where PcMenu is used.  Registration Forms can be sent by post to
  217.    the  address below.   Users who  have Internet  access can  use the file
  218.    supplied and e-mail it to 'pcmenu@arcadia.cs.rmit.EDU.AU'.
  219.  
  220.    You are under  no obligation to do  so.  However, if you  do, the Author
  221.    may, from  time to time, inform you as to the availability of updates to
  222.    this software.
  223.  
  224.    Although PcMenu is available to you  for no charge, the Author has spent
  225.    considerable time,  effort, and money on  this project.  If  you feel he
  226.    should  be further  rewarded,  please feel  free  to send  any  monetary
  227.    donation you feel appropriate to the author, at the address below.
  228.  
  229.    Credits
  230.    This  software was  written  and designed  by  Brian Habel,  a  computer
  231.    programmer  and system administrator at the Bundoora Campus of the Royal
  232.    Melbourne Institute of Technology.
  233.  
  234.    Special mention is made  of Michael Bernardi [mike@childsoc.demon.co.uk]
  235.    from the Children's  Society, London, England.  Without his constructive
  236.    comments, and amendments to  this document, this release would  not have
  237.    been possible.  Also thanks to Ivan Cekalovic, Frank Manzi, and the rest
  238.    of the other Beta testers from RMIT.  ( Thanks Guys ! )
  239.  
  240.    Lastly  thanks to  all the  others, who  made constructive  comments and
  241.    suggestions about  PcMenu Version 2.1   Your  input to this  release has
  242.    been invaluable.
  243.  
  244.  
  245.    Contacting the Author
  246.    Those people who would like to make suggestions, comments or bug reports
  247.    can contact the author ( for those lucky enough to  have Internet access
  248.    ) by e-mail to 'pcmenu@arcadia.cs.rmit.EDU.AU'.
  249.  
  250.    Those  without  Internet  access can  reply  by  post  to the  following
  251.    address:-
  252.  
  253.                   Brian Habel
  254.                   c/o PO BOX 518
  255.                   Heathmont 3135
  256.                   Victoria, Australia.
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.    PcMenu Version 3.0 User Manual                                      Page 2
  265.  
  266.    Introduction
  267.  
  268.    What is PcMenu
  269.         PcMenu is  a software  package which allows  System Administrators,
  270.         Managers of  Local Area Networks, or  even the lone home  user of a
  271.         standalone  system to organise the software on their system so that
  272.         it can be easily accessed.
  273.  
  274.         This is achieved by creating customised screen menu's from a series
  275.         of menu scripts, which are small ascii text files, which define the
  276.         contents of each menu.  A menu can lead to other menus, referred to
  277.         as  sub-menus,  allowing  the  user or  administrator  to  organise
  278.         software in a variety of ways.
  279.  
  280.         PcMenu is fully compatible with NOVELL's NETWARE MENU utility 'menu
  281.         script' files.  Users of PcMenu in a NOVELL Network environment can
  282.         easily install  PcMenu as  the scripts  from NOVELL's  menu utility
  283.         work in the same way.  Although PcMenu is NOVELL compatible, it has
  284.         even more to offer, such as  storing sub-menus in other files  from
  285.         where they  are called.   Also, an  optional screen saver  has been
  286.         added  to reduce the  chance of 'burn  on'.  PcMenu  even has mouse
  287.         support  !  With the PalDef utility  you can even choose and define
  288.         what colour you want for your menus.
  289.  
  290.         PcMenu runs options in  DOS via Batch Files with no memory overhead
  291.         !  Yes, you  can even  load  Terminate and  Stay Resident  ( TSR  )
  292.         programs with PcMenu.
  293.  
  294.         You may like to  think of PcMenu as a batch file  database and each
  295.         menu option is the link to its associated batch file.  Now there is
  296.         no need  to have a plethora  of batch files roaming  your system as
  297.         all files can be integrated into  an organised group of files or if
  298.         preferred, just one !
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.    PcMenu Version 3.0 User Manual                                      Page 3
  320.  
  321.    Installation of PcMenu
  322.    System Requirements
  323.  
  324.         PcMenu will run on an IBM PC, XT, AT, or true 100% compatible, with
  325.         at least 256k  of free memory ( the more  memory available the more
  326.         menus can be  displayed at the same time ), with either a MDA, CGA,
  327.         EGA, VGA display.  PcMenu is supported, and well suited,  to run in
  328.         a Network  environment, it  has been  tested extensively  on Novell
  329.         Netware  v3.11, but  should  work equally  as  well on  most  other
  330.         platforms .
  331.  
  332.    Copying the files to your System
  333.  
  334.         Installation on a standalone PC
  335.         PcMenu is  distributed in ZIP  format.   You will need  to have  an
  336.         appropriate  unarchiving  utility  that  can  handle  this  format.
  337.         Configuration files and example  menu definition files are designed
  338.         to  work  from the  C:\PCMENU directory.    It is  recommended that
  339.         newcomers  to  PcMenu  install  the  software  this  way  first, if
  340.         possible.
  341.  
  342.         1.    Extract  the files  into  C:\PCMENU  with  the following  DOS
  343.         commands
  344.                   cd  c:
  345.                   md c:\pcmenu
  346.                   cd c:\pcmenu
  347.                   unzip a:\pcmenu30.zip
  348.  
  349.         Substitute a:  in the  last command  with  the drive  letter (  and
  350.         directory  if  appropriate  )  containing the  pcmenu.zip  file  if
  351.         necessary
  352.  
  353.         2.  PcMenu is ready  to run, the Example Menus supplied.   To load,
  354.         simply run the demo.bat1 file supplied by typing :-
  355.  
  356.                   demo <Enter>
  357.  
  358.         You are now recommended to read the next section 'How it all works'
  359.         followed by the section 'Setting up the ini file'.
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.                               
  369.  
  370.         1PcMenu  uses a batch file called 'DEMO.BAT' to run the supplied demo
  371.     menu  files, however  this name can  be changed to any  batch filename you
  372.     prefer.  Hereafter this file will be referred to as simply 'MENU.BAT'
  373.  
  374.    PcMenu Version 3.0 User Manual                                      Page 4
  375.  
  376.    How it all works
  377.  
  378.         PCMENU.EXE is not usually invoked from the command line, rather the
  379.         entire system  is driven from a  DOS batch file called  MENU.BAT of
  380.         which a listing is made below:-
  381.  
  382.         @echo off
  383.         rem
  384.         rem  Place this batch file in your PATH
  385.         rem  Setup a environment variable specifying where the Menu script
  386.         rem  is in %menu% before running this batch file.
  387.         rem  This can be done here, but is best done through Network Login
  388.         rem  Scripts if running on a network.
  389.         rem
  390.         rem  Only set, if not already set.
  391.         set pcmenu_ini=c:\pcmenu
  392.         if %menu%+==+ set menu=c:\pcmenu\brian.mnu
  393.         if %othermenu%+==+ set othermenu=c:\pcmenu\brian2.mnu
  394.         rem Some programs muck screens up, to fix run mode command
  395.         mode co80
  396.         rem mode mono
  397.         pcmenu %menu%
  398.         if errorlevel 1 goto exit
  399.         rem
  400.         rem Using clever arrangement of environment variables
  401.         rem you can set up exactly where you want pcmu$bat.bat file
  402.         rem to be written.
  403.         rem  ie.  f:%home%\pcmu$%stn%.bat
  404.         rem  Also you can setup a unique var ( ie %stn% ) for each workstation
  405.         rem on a Network, then each user has his own batch file generated.
  406.         rem
  407.         rem The default is setup below
  408.         rem
  409.         cls
  410.         c:\pcmenu\pcmu$bat.bat
  411.         :exit
  412.  
  413.         This file will load PcMenu with the Menu Definition File located in
  414.         the  path  defined  in the  DOS  environment  variable  MENU.   The
  415.         demonstration menus have the screen saver set to a time  value of 5
  416.         minutes in the Ini file.
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.    PcMenu Version 3.0 User Manual                                      Page 5
  430.  
  431.         When an option is  selected from a  menu, and that option  contains
  432.         DOS Batch file  code ( ie.  not a sub-menu ), PcMenu will write the
  433.         batch file code to the file PCMU$BAT.BAT ( in the directory defined
  434.         by  PCMENU_BATCH  )  and record  which  menu  and  option that  was
  435.         selected by creating a  temporary file in the directory  defined by
  436.         the DOS environment  variable PCMENU_TEMP.  PcMenu then  exits back
  437.         to  MENU.BAT  where the  next  instruction will  execute  the newly
  438.         created  batch  file and  hence the  option  just selected.   After
  439.         completion,   MENU.BAT  is   re-executed  (   this  is   done  from
  440.         PCMU$BAT.BAT ),  and PcMenu  is  reloaded, and  upon detecting  the
  441.         presence of  the temporary file  created earlier, will  restore its
  442.         state to the instant before the option was selected.
  443.  
  444.    Upgrading from PcMenu Version 2.1
  445.         PcMenu Version 3.0  is fully downward compatible with  Version 2.1.
  446.         Hence, all that is required to upgrade to version 3.0 is to replace
  447.         the  files PCMENU.EXE and PALDEF.EXE from version 2.1 with the ones
  448.         from version 3.0.   All  DOS environment variables  ( as  explained
  449.         below ) used  in the earlier release are still supported.  However,
  450.         users are  strongly encouraged to use  the ini files to  enable the
  451.         new features of  PcMenu.   See the  section below  and the  section
  452.         entitled 'Setting up the INI file'.
  453.  
  454.         Users  of  Version 2.1  are also  recommended  to read  Appendix A.
  455.         'Compatibility between Version 3.0 and Version 2.1'
  456.  
  457.    Implementation
  458.         Users  who are installing PcMenu for the first time are recommended
  459.         using the 'ini'  file mechanism  and skip to  the section  entitled
  460.         'Setting up the INI file'.
  461.  
  462.         The following is intended for those Upgrading from Version 2.1
  463.  
  464.         PcMenu uses two mechanisms to tell it where its files are:-
  465.  
  466.         1 ).   The first  way is  to use  the Version  2.1 DOS  Environment
  467.         Variables.
  468.  
  469.              MENU           -   Used  only  by  MENU.BAT  and  defines  the
  470.                             directory and filename of the PcMenu Definition
  471.                             File.
  472.  
  473.              PCMENU_PALETTE - Defines the Directory where Paldef and PcMenu
  474.                             are   to   find   the   colour   palette   file
  475.                             PCMU$PAL.DAT
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.    PcMenu Version 3.0 User Manual                                      Page 6
  485.  
  486.              PCMENU_TEMP         - Defines the Directory where PcMenu finds
  487.                                  its  temporary  file when  reloading after
  488.                                  executing a  DOS batch file.   The file is
  489.                                  called PCMU$TMP.DAT
  490.  
  491.              PCMENU_HEADER  - Defines  the Directory where PcMenu looks for
  492.                             the    Information    Box    definition    file
  493.                             PCMU$HDR.DAT
  494.  
  495.              PCMENU_BATCH        -  Defines  the  Directory   where  PcMenu
  496.                                  writes the DOS Batch file for the selected
  497.                                  option.  The MENU.BAT batch file also uses
  498.                                  this DOS Environment Variable.
  499.  
  500.              DOS  Environment Variables can be set in the AUTOEXEC.BAT file
  501.              or from login scripts within a network environment.
  502.  
  503.              If  any of the environment variables are not set then PcMenu (
  504.              and  PalDef for  the PCMENU_PALETTE variable  ) will  look for
  505.              files in the current directory, ( or in the 'ini' file if used
  506.              , see  below ) the instant they require it!  It is recommended
  507.              that if this approach is used that all variables are set.
  508.  
  509.         2 )   The second approach, and preferred ( especially if running on
  510.         a Network ) is to use PcMenu's 'ini' file.  For  details on its use
  511.         see the next section below entitled 'Setting up the INI file'
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.    PcMenu Version 3.0 User Manual                                      Page 7
  540.  
  541.    Setting up the INI file
  542.         New in PcMenu Version 3.0 is the 'initialisation' file, more easily
  543.         referred  to as the 'ini' file.  The ini filename used by PcMenu is
  544.         PCMU$INI.DAT  and is  located by  the program  in two  ways.   ( As
  545.         PalDef uses this file as well, to locate  the directory the palette
  546.         file is located in, it uses these same mechanisms as well )
  547.  
  548.         1 )  By using the DOS Environment Variable PCMENU_INI, which is set
  549.         to the DIRECTORY containing the ini file.
  550.  
  551.         or
  552.  
  553.         2 )  by using the "/I path " option on the command line ( of either
  554.         PCMENU.EXE  or  PALDEF.EXE  ).    Where  "path"  is  the  DIRECTORY
  555.         containing the ini file.
  556.  
  557.         The ini file contains options to tell PcMenu where to  locate files
  558.         that it needs to use during operation.  It is also used for setting
  559.         up new features introduced to PcMenu Version 3.0.
  560.  
  561.    INI File Options
  562.         The  ini  file  is just  an  ordinary  text  file containing  lines
  563.         consisting  of options and their  associated values.   Also you can
  564.         use the '#'character to denote a comment line to help remind you of
  565.         what each option is for, and for other incidental information.  Any
  566.         text appearing after a '#' character is ignored by PcMenu.
  567.  
  568.         It  is also possible to supply information from the DOS environment
  569.         to  any  of  the options  in  part  or  whole by  using  the  <   >
  570.         characters.   Simply place the name of the DOS environment variable
  571.         inside the < > characters ( eg.  <COMSPEC> will be  replaced by the
  572.         path of where COMMAND.COM is located ).
  573.  
  574.         The ini  file  is hopefully  self  explanatory (  a  listing of  an
  575.         example ini file is located in the Appendix ), however some options
  576.         perhaps require further explanation.
  577.  
  578.         MENU_BATCH
  579.              As  explained previously  in the  section 'How  it all  works'
  580.              PcMenu is driven from a DOS batch file.  By  default the batch
  581.              file  name that  PcMenu uses  is MENU.BAT.   Users  may prefer
  582.              another name ( eg.  PCMENU.BAT  ) to distinguish it from other
  583.              menu  systems currently installed .  PcMenu uses this value to
  584.              correctly ( re )call the batch file that will enable itself to
  585.              reload, after an option has been selected and completed.
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.    PcMenu Version 3.0 User Manual                                      Page 8
  595.  
  596.         BATCH_FILENAME
  597.              This   option  specifies   an   alternate  filename   for  the
  598.              PCMU$BAT.BAT.  This is  of primary importance if running  on a
  599.              network, particularly when  the same user  logs on twice  with
  600.              the  same  account.    Most  networks  have  the   ability  to
  601.              distinguish  which  workstation  a   user  is  using,  and  by
  602.              employing this information  by storing it in a DOS environment
  603.              variable.2  This enables PcMenu to create different file names
  604.              for the  same  network account,  allowing the  menu system  to
  605.              operate correctly for each user.
  606.  
  607.              For  an illustration of how this is implemented see Appendix C
  608.              The format of the  initialisation file & use with  NetWare for
  609.              an example on a Novell network.
  610.  
  611.         INFO_BOX_UPDATE
  612.              Network System  Administrators may, from time  to time, change
  613.              the  contents  of the  Information Box.    In PcMenu  V.1, the
  614.              Information  Box was  only updated  when the  System was  ( re
  615.              )loaded.   However, with this option you can have PcMenu check
  616.              the PCMU$HDR.DAT file to see if it has been modified.  It does
  617.              this  by simply checking to see if  the date and time stamp on
  618.              the file has changed since the last time it was modified.  The
  619.              value supplied  to this option is the time ( in seconds ) that
  620.              you  want PcMenu to check the time  stamp.  Note however, that
  621.              with smaller values, more  load will be placed on  the server.
  622.              As to the correct value, one will have to experiment.
  623.  
  624.              If a  value of  zero is  specified  then no  time checking  is
  625.              performed and PcMenu will only update the Information Box when
  626.              reloaded.  ( As was the case with PcMenu Version 2.1 )
  627.  
  628.         SCREEN_SAVER
  629.              As an alternative  to the  /s command line  parameter you  can
  630.              place the value in  seconds of inactivity you want  the screen
  631.              saver to activate.
  632.  
  633.              A value of zero will disable the screen saver
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.                               
  645.  
  646.         2Check with  your networking system documentation  as to  how you can
  647.     store values of workstation ID's into the DOS environment.
  648.  
  649.    PcMenu Version 3.0 User Manual                                      Page 9
  650.  
  651.         ALPHA_KEYING
  652.              PcMenu  now supports  "Alphanumeric Keying".   In  addition to
  653.              using the arrow keys users may type the option title they want
  654.              to use.  Only  enough characters to uniquely qualify  the menu
  655.              option is necessary.  Once the option required  is highlighted
  656.              you can select ( execute ) it by pressing the Enter key.
  657.  
  658.         TABS
  659.              The TABS option allows  System Administrators to easily format
  660.              Menu options in columns.   Each value separated by  commas, is
  661.              the number of  spaces from the left edge of  the menu you want
  662.              to start the text from.  To have PcMenu 'tabulate' insert true
  663.              tab  characters  into  the  text, where  each  succeeding  tab
  664.              character  tabulates to the next column  specified in the TABS
  665.              list.   If there are more tab characters in a line than values
  666.              specified in the TABS list they are ignored.
  667.  
  668.         HELP_BAR_COLOURS
  669.              This option allows  the option  of setting the  colour of  the
  670.              Help Bar  located at the  bottom of  the screen to  follow the
  671.              global colours  specified for  the Information Box,  or always
  672.              retaining the system default colours.
  673.  
  674.         SAVER_MESSAGES
  675.              The screen saver now displays messages across the screen every
  676.              few seconds.   There  are two  built into  the system  with an
  677.              optional  third which is  user defined  ( see  below ).   This
  678.              option  allows the  user either  to enable  or to  disable all
  679.              screen saver messages.
  680.  
  681.         SCREEN_SAVER_MESSAGE
  682.              Useful messages can be  displayed as part of the  screen saver
  683.              with this  option.   Every  third  message that  is  displayed
  684.              contains the text assigned to this option.  The length of this
  685.              message cannot exceed 80 characters.
  686.  
  687.              Note that text must be enclosed in quotation ( " ) characters,
  688.              otherwise text will not be displayed as intended.
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.    PcMenu Version 3.0 User Manual                                     Page 10
  705.  
  706.    How To Use PcMenu
  707.  
  708.    Planning Your Menus
  709.  
  710.         Some thought must be given to what a menu should contain.  This all
  711.         depends on who is going to be using the system and what environment
  712.         the user is in.  For example, a user in  an educational environment
  713.         may be  using PC's connected  via a local  area network.   This may
  714.         mean   that  the  user  may  need  to  access  various  amounts  of
  715.         information from various software  packages.  One plan might  be to
  716.         put  all common  software  packages  into  groups,  say  all  'Word
  717.         Processors'  in one  group,  and all  'Spread  Sheets' in  another.
  718.         These  groups  could then  become, each  in themselves,  a sub-menu
  719.         which can then be accessed from a main menu.  Another plan might be
  720.         to sort the software packages on a most used basis, placing options
  721.         for  these in the  first main menu, and  other less frequently used
  722.         software packages in sub-menus.
  723.  
  724.    Defining Your Menus
  725.  
  726.         As mentioned before, PcMenu  uses the same technique as  the NOVELL
  727.         NETWARE Menu utility.  Those users who are familiar with the NOVELL
  728.         NETWARE menu utility should have little difficulty in designing and
  729.         implementing menu scripts for PcMenu.
  730.  
  731.         Essentially, each menu has a Title and at least one option up to an
  732.         upper limit of fifty.  A complete menu definition has the following
  733.         form.
  734.  
  735.              %menu_title[,[row_placement ][,[column_placement][,palette]]]
  736.              Menu Option[,filename]
  737.                             |
  738.                   Dos Batch file commands
  739.                             |
  740.                             OR
  741.                   %sub-menu_title[,alternative_filename]
  742.  
  743.  
  744.         Looking  at this in more  detail, each menu  definition starts with
  745.         the % character which must appear in the first column  of the file,
  746.         followed directly by  the title of this menu.   The title here will
  747.         be the  title that is  displayed in  the title area  of your  menu.
  748.         Following the title there  are several optional values that  may be
  749.         added for  this menu.  The  first two of these  are associated with
  750.         the location  on the screen you  want the menu to  be displayed and
  751.         the third  option is the palette number which defines the colour of
  752.         the menu.  These options will be discussed in more detail later.
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.    PcMenu Version 3.0 User Manual                                     Page 11
  760.  
  761.         On the following lines appear the options that appear in the  menu.
  762.         Each option  that you wish  to add, must  again start in  the first
  763.         column of the file and  as before, what you type here  is displayed
  764.         as your option in the menu.
  765.  
  766.         The next  lines are what  action is  to be taken  for this  option.
  767.         They usually consist  of standard  DOS batch file  commands.   Each
  768.         Batch file command must be offset by at least a space.  That is, it
  769.         must start  in at least  the second  column of the  menu definition
  770.         file.  You may find by using  the tab character to space DOS  batch
  771.         file  commands, you can keep  your menu options  more distinct from
  772.         each other.  PcMenu  will continue reading batch file  commands for
  773.         this option until it finds  the next option title, which  should be
  774.         located in the first column.
  775.  
  776.         Alternatively, instead of a batch  file command, you can place a  %
  777.         character  and  immediately following,  the  name  of another  menu
  778.         definition.   This creates a link  to what is known  as a sub-menu.
  779.         You can have sub-menus located in a different file if  you wish, in
  780.         which case you add after the sub-menu name the complete DOS PATH of
  781.         the filename in  which this  sub-menu is contained  separated by  a
  782.         comma.
  783.  
  784.         Example:
  785.  
  786.         %Brian's Menu
  787.         Word Processors
  788.              %Word Processors Menu
  789.         Dos Command
  790.              echo off
  791.              @"Enter your DOS command"
  792.         Other Options
  793.              %Submenu File,C:\PCMENU\PCM_SUB.MNU
  794.         %Word Processors Menu,,,2
  795.         Word Perfect 5.1
  796.              echo off
  797.              c:\wp51
  798.              wp
  799.              cd c:\
  800.         PC  Write
  801.              echo off
  802.              cd c:\pcwrite
  803.              ed
  804.              cd c:\
  805.  
  806.  
  807.  
  808.  
  809.  
  810.  
  811.  
  812.  
  813.  
  814.    PcMenu Version 3.0 User Manual                                     Page 12
  815.  
  816.         This  menu definition file contains a main menu ( entitled 'Brian's
  817.         Menu' ) and one sub-menu (  entitled 'Word Processors Menu' ).  The
  818.         main menu uses default values for menu location and palette colour.
  819.         The sub-menu  uses the   default  menu location  but uses  the user
  820.         defined palette colour 2.
  821.  
  822.         The  'Other Options' is actually held in a file called PCM_SUB.MNU,
  823.         with a title of %Submenu File.
  824.  
  825.         The main menu would display something like the following.
  826.  
  827.  
  828.  
  829.                         ╔══════════════════════╗
  830.                         ║     Brian's Menu     ║
  831.                         ╠══════════════════════╣
  832.                         ║  │  Word Processors  ║
  833.                         ║  │  Dos Command      ║
  834.                         ║  │  Other Options    ║
  835.                         ╚══════════════════════╝
  836.  
  837.                        Fig 1.  Example Menu 'Brian.mnu'
  838.  
  839.         Notice that the menu title is centred on the screen.  If you do not
  840.         want the title  centred , it must  be enclosed in  double quotation
  841.         marks.  The menu title will then be left justified.
  842.  
  843.         Also  note that  menu items  are not  sorted alphabetically.   Menu
  844.         items appear in the  menu in the same order that they appear in the
  845.         menu definition file.
  846.  
  847.    Option Hiding
  848.         After  the menu  option,  you can  add  an optional  filename  path
  849.         separated  by a  comma.  PcMenu  will check  that this  file exists
  850.         before displaying  and making that  option available  to the  user.
  851.         Network  Administrators  can  (  and  usually  do  )  make  certain
  852.         directories   available   to   selected   users.      This   allows
  853.         administrators to reveal options  to a select group of  users using
  854.         the  same menu definition file, by simply specifying a file located
  855.         in the restricted directory after an option.
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869.    PcMenu Version 3.0 User Manual                                     Page 13
  870.  
  871.         For an Illustration on how option hiding is implemented, follow the
  872.         following
  873.         example  ( Using the previous Menu Script )
  874.  
  875.              %Brian's Menu
  876.              Word Processors
  877.                   %Word Processors Menu
  878.              Dos Command
  879.                   echo off
  880.                   @"Enter your DOS command"
  881.              Other Options,C:\CONFIG.SYS
  882.                   %Submenu File,C:\PCMENU\PCM_SUB.MNU
  883.              %Word Processors Menu,,,2
  884.              Word Perfect 5.1
  885.                   echo off
  886.                   c:\wp51
  887.                   wp
  888.                   cd c:\
  889.              PC  Write,C:\DOS\FORMAT.COM
  890.                   echo off
  891.                   cd c:\pcwrite
  892.                   ed
  893.                   cd c:\
  894.  
  895.         In  this  example,  the main  menu  option  'Other  Options' has  a
  896.         filename 'C:\CONFIG.SYS'.  For this option to be displayed the file
  897.         C:\CONFIG.SYS must exist and be readable.  ( Also, since the option
  898.         calls for an Alternate sub-menu the alternate file must also exist,
  899.         see the next section below )3.
  900.  
  901.         There is also  a filename specified after the 'PC  Write' option in
  902.         the 'Word Processors Menu',  again for this option to  be displayed
  903.         to the user, the File C:\DOS\FORMAT.COM must exist !  What filename
  904.         you use is  unimportant, it need have no  relevance to the commands
  905.         specified for an option.  The filename is purely a simple mechanism
  906.         to  either  display  the option  to  or  hide  the  option  from  a
  907.         particular user.
  908.  
  909.  
  910.  
  911.  
  912.  
  913.  
  914.  
  915.  
  916.                               
  917.  
  918.         3PcMenu  checks  for Option  Hiding  prior  to  the  existence of  an
  919.     Alternate Sub Menu file.  You can  still use the option hiding  technique,
  920.     for options that  call Alternate Sub  Menu Files.  In  this case both  the
  921.     Option 'filename'  and the  Alternate sub-menu 'filename'  must exist  for
  922.     that option to appear in the menu!
  923.  
  924.    PcMenu Version 3.0 User Manual                                     Page 14
  925.  
  926.    Alternate Sub Menu Files
  927.         Sub-menus located in alternate files will only load if that file is
  928.         accessible.   If the  alternate file  cannot be  found or read  THE
  929.         ENTIRE MENU ENTRY FOR THIS OPTION WILL NOT BE DISPLAYED.   That is,
  930.         if  PcMenu cannot load  a sub-menu from  an alternate  file then it
  931.         will ignore the entire option from the current menu definition when
  932.         displayed.   ( If you can't read the option definition, why display
  933.         an  option to  the user.   )   On  the other  hand if  the sub-menu
  934.         definition is made and no alternate file is allocated, the sub-menu
  935.         definition must be located  in the current file otherwise  an error
  936.         will result.
  937.  
  938.    Locating Your Menus On The Screen
  939.         By default, if there are no optional values supplied after the menu
  940.         title name for a menu definition, the menu will be displayed in the
  941.         middle of  the screen.  To  place the menu in  a different location
  942.         you  supply two  values which  adjust the  horizontal and  vertical
  943.         position  of the  menu.   Lines are  measured from  the top  of the
  944.         screen to the centre of the menu in the horizontal  plane, and from
  945.         the sides of the screen  to the centre of the menu  in the vertical
  946.         plane.  So to calculate  the final position of your menu  apply the
  947.         following formula.
  948.  
  949.                                  A + B/2 = C
  950.                   where
  951.                        A    =    the number of lines above the menu
  952.  
  953.                        B/2  =    half  the  number  of  lines  in the  menu
  954.                                  counting the borders and title
  955.  
  956.                        C    =    row_placement value
  957.  
  958.         and for the column_placement value
  959.  
  960.                        A    =    the number  of columns to the  left of the
  961.                                  menu
  962.  
  963.                        B    =    half the column width of the menu
  964.  
  965.                        C    =    column_placement value
  966.  
  967.         If you  make the placement values  too large or too  small the menu
  968.         will be positioned at the appropriate edge of the screen.  You need
  969.         not worry about  moving the menu off the screen.   If the placement
  970.         values are ZERO or omitted they revert back to default values,  the
  971.         centre of the screen for that plane ( horizontal / vertical ) .
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.    PcMenu Version 3.0 User Manual                                     Page 15
  980.  
  981.    Using Your Mouse With PcMenu
  982.  
  983.         PcMenu supports  any Microsoft  Compatible mouse connected  to your
  984.         system!
  985.  
  986.         While the mouse  pointer ( indicated by  the red block ) is  over a
  987.         menu  option, pressing the left button once will move the highlight
  988.         bar to  that option.   Pressing  the mouse  button  twice in  rapid
  989.         succession will select that option.  ( As if the Enter key had been
  990.         pressed ).
  991.  
  992.         While the mouse pointer is over any  part of a menu ( including the
  993.         menu  title or any of the menu  borders ), pressing the right mouse
  994.         button will remove the current menu and return to the previous one.
  995.         ( Or will exit the program if this was the 'top level' menu.  )
  996.  
  997.         After placing the menu  pointer on the horizontal border  above the
  998.         top  menu item  display, pressing  the left  button will  cause the
  999.         highlight  bar to  scroll through the  list of  options 'up-wards'.
  1000.         Likewise, if the mouse pointer is positioned at the horizontal menu
  1001.         border beneath  the last menu  option displayed, pressing  the left
  1002.         button  will cause the highlight bar  to scroll through the list of
  1003.         options 'down-wards'.
  1004.  
  1005.         The Paldef utility uses the mouse in the same way as PcMenu does.
  1006.  
  1007.  
  1008.  
  1009.  
  1010.  
  1011.  
  1012.  
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.  
  1019.  
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025.  
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.  
  1032.  
  1033.  
  1034.    PcMenu Version 3.0 User Manual                                     Page 16
  1035.  
  1036.    More On Batch File Programming
  1037.  
  1038.         Normally,  you can  place  any  batch  file  command  in  the  Menu
  1039.         definition file when  defining a  menu option.   There are  however
  1040.         some special characters that can  be used to enhance how your  menu
  1041.         option executes.
  1042.  
  1043.         PcMenu does support the use of @ variable characters as used in the
  1044.         NETWARE Menu utility.   These characters allow you to  ask the user
  1045.         for further information interactively, which will then be added  to
  1046.         the batch file when executed.  The syntax is as follows.
  1047.  
  1048.              @[n]"prompt text"
  1049.  
  1050.         where n is the repeater or  variable number of this prompt.   If no
  1051.         variable  number is  supplied  then the  user supplied  information
  1052.         cannot be reused later within the batch file definition.
  1053.  
  1054.         In the  following example  a menu option  has been created  to copy
  1055.         files
  1056.  
  1057.              COPY A FILE
  1058.                   copy @1"Enter source file name" @2"Enter destination"
  1059.                   echo @1 copied to @2
  1060.  
  1061.         The first line uses the DOS copy command.  The first @ command asks
  1062.         the user for the pathname of the source file and the second for the
  1063.         destination.
  1064.  
  1065.         To  fully understand  how PcMenu  Implements @  variables, you  are
  1066.         encouraged  to experiment  a  little and  to  look at  the  runtime
  1067.         batchfile that is generated.
  1068.  
  1069.         PcMenu  supports  the use  of the  '!'  character in  the following
  1070.         manner.    Any  DOS batchfile  command  that  starts  with the  '!'
  1071.         character will cause  PcMenu to  exit to DOS  and not reload  AFTER
  1072.         this command  has executed.  Hence,  on a Novell Network  you could
  1073.         have an option in a menufile...
  1074.  
  1075.                   Logout from Network
  1076.                        !Logout
  1077.  
  1078.              ...  and  after the Logout  command has  executed the PC  will
  1079.         remain at the DOS prompt.
  1080.  
  1081.  
  1082.  
  1083.  
  1084.  
  1085.  
  1086.  
  1087.  
  1088.  
  1089.    PcMenu Version 3.0 User Manual                                     Page 17
  1090.  
  1091.         PcMenu also supports  the use of < >  symbols for retrieving values
  1092.         from the  DOS environment.  You  may use these in  menu title names
  1093.         and menu option names.  You cannot use them when writing Batch file
  1094.         commands,  instead  use the  standard DOS  Batch file  % characters
  1095.         instead.
  1096.  
  1097.         For example suppose  you have  a choice between  two printers,  one
  1098.         called Document and the other called Draft.  If you set environment
  1099.         variables with the DOS SET command as follows
  1100.  
  1101.               SET OTHER_PRINTER=Document
  1102.               SET CURR_PRINTER=Draft
  1103.  
  1104.         then you can have a Menu Option defined as
  1105.  
  1106.         Change printer to <OTHER_PRINTER>
  1107.              capture q=%curr_printer%
  1108.              set tmp=%other_printer%
  1109.              set other_printer=%curr_printer%
  1110.              set curr_printer=%tmp%
  1111.  
  1112.         Then as  this option is selected  it will 'swap' the  values of the
  1113.         two DOS environment variables and also the menu option will display
  1114.         the unselected printer.
  1115.  
  1116.         NOTE
  1117.         With  DOS you may  use the @ character  to suppress statements from
  1118.         being displayed and  the < >  symbols for file  redirection.   With
  1119.         PcMenu  the @, <, >,  characters have special  meanings.  In PcMenu
  1120.         the < > characters are used to define DOS environment variables for
  1121.         Menu Titles and Menu  Options.  These characters retain  their file
  1122.         redirection function in the  DOS BATCH definition area of  the Menu
  1123.         Definition file.   The @  character, on the  other hand,  cannot be
  1124.         used  as the  DOS  statement suppression  character,  as it  has  a
  1125.         special  meaning to  PcMenu throughout  the entire  Menu Definition
  1126.         file.
  1127.  
  1128.         There is little reason to use @ characters as statement suppressors
  1129.         as they can be used in the start up batch file in  conjunction with
  1130.         the batch  file  'echo  off' command.    ( See  the  section  above
  1131.         entitled 'How it all works' )
  1132.  
  1133.  
  1134.  
  1135.  
  1136.  
  1137.  
  1138.  
  1139.  
  1140.  
  1141.  
  1142.  
  1143.  
  1144.    PcMenu Version 3.0 User Manual                                     Page 18
  1145.  
  1146.    PcMenu's Information Box
  1147.         A nice feature of PcMenu is  the Information Box.  If you  create a
  1148.         file called PCMU$HDR.DAT and place text in it, It will be displayed
  1149.         at  the top  of the  screen inside  the Copyright  Information Box.
  1150.         This allows System Administrators  of Networks to Display Important
  1151.         messages to users at a moments notice.  You can tell also PcMenu to
  1152.         get  different  Header Information  files  for  different users  by
  1153.         setting the  DOS environment  variable called PCMENU_HEADER  to the
  1154.         directory  in   which  PCMU$HDR.DAT  is  located   for  that  user.
  1155.         Alternatively, you can  set the  location of the  directory in  the
  1156.         'ini' file!  See the section 'Setting Up the INI file'.
  1157.  
  1158.         You can change  the colour of  the Information Box  by a series  of
  1159.         colour codes.
  1160.  
  1161.         To  change the colour  of the Information Box  from its default the
  1162.         first line of the  file PCMU$HDR.DAT must contain a  combination of
  1163.         the following:-
  1164.  
  1165.                   $b   -    To change the background colour to colour  n.
  1166.  
  1167.                   $f   -    To change the foreground colour to colour  n.
  1168.  
  1169.                   $s   -    To change the borders of the Information Box to
  1170.                             colour  n.
  1171.  
  1172.                   (  Where  n   is  a digit  corresponding to  its assigned
  1173.                   colour as defined in the table blow )
  1174.  
  1175.  
  1176.         This then in effect sets up a new set of colour defaults.
  1177.  
  1178.         To  change  the colour  during  a  line of  text  you  can use  the
  1179.         following :-
  1180.  
  1181.                   @f   -    To change the foreground colour to colour  n.
  1182.  
  1183.                   @b   -    To change the background colour to colour  n.
  1184.  
  1185.                   (  Where   n   is a digit  corresponding to  its assigned
  1186.                   colour as defined in the table blow )
  1187.  
  1188.         This enables you to  change the colour of text 'on  the fly', so to
  1189.         speak, which will allow you to create colourful message!
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.  
  1196.  
  1197.  
  1198.  
  1199.    PcMenu Version 3.0 User Manual                                     Page 19
  1200.  
  1201.         NOTE
  1202.         Background colour numbers must be between the  range of  0 ≤ n ≥  7
  1203.         whereas, foreground colours must be within the range of  0 ≤ n ≥ 15
  1204.         .
  1205.  
  1206.         Colours numbers are defined as follows
  1207.  
  1208.                           ╔══════════════════════╗
  1209.                           ║    Information Box   ║
  1210.                           ║    Colour  Numbers   ║
  1211.                           ╠═════╤════════════════╣
  1212.                           ║   0 │      Black     ║
  1213.                           ║─────┼────────────────║
  1214.                           ║   1 │      Blue      ║
  1215.                           ║─────┼────────────────║
  1216.                           ║   2 │      Green     ║
  1217.                           ║─────┼────────────────║
  1218.                           ║   3 │      Cyan      ║
  1219.                           ║─────┼────────────────║
  1220.                           ║   4 │       Red      ║
  1221.                           ║─────┼────────────────║
  1222.                           ║   5 │     Magenta    ║
  1223.                           ║─────┼────────────────║
  1224.                           ║   6 │      Brown     ║
  1225.                           ║─────┼────────────────║
  1226.                           ║   7 │   Light Grey   ║
  1227.                           ║─────┼────────────────║
  1228.                           ║   8 │    Dark Grey   ║
  1229.                           ║─────┼────────────────║
  1230.                           ║   9 │   Light Blue   ║
  1231.                           ║─────┼────────────────║
  1232.                           ║  10 │   Light Green  ║
  1233.                           ║─────┼────────────────║
  1234.                           ║  11 │   Light Cyan   ║
  1235.                           ║─────┼────────────────║
  1236.                           ║  12 │    Light Red   ║
  1237.                           ║─────┼────────────────║
  1238.                           ║  13 │  Light Magenta ║
  1239.                           ║─────┼────────────────║
  1240.                           ║  14 │     Yellow     ║
  1241.                           ║─────┼────────────────║
  1242.                           ║  15 │      White     ║
  1243.                           ╚═════╧════════════════╝
  1244.                              Fig 2.  Colour Table
  1245.  
  1246.         Text is automatically centred unless quoted with double quotes, in
  1247.         which case, text will be left justified and placement of words can
  1248.         be calculated manually.
  1249.  
  1250.         You can also use the < > symbols to place the value of any DOS
  1251.         environment variable within a line as well.
  1252.  
  1253.  
  1254.    PcMenu Version 3.0 User Manual                                     Page 20
  1255.  
  1256.         Example
  1257.         The following is an example of a PcMenu Information Box Definition
  1258.         file ( PCMU$HDR.DAT ).
  1259.  
  1260.         $b1$f15$s14
  1261.         @f2H@f3e@f4l@f5l@f6o @f2T@f3h@f4e@f5r@f6e
  1262.  
  1263.         ( The first line sets up the Information Box with a Blue
  1264.         background, white foreground, with a yellow border.  The second
  1265.         line will print the string 'Hello There' in a multitude of colours
  1266.         - a rainbow effect if you like )
  1267.  
  1268.         The size of the Information box is limited to 15 lines to prevent
  1269.         forcing Menus off the bottom of the screen, although anything over
  1270.         5 lines begins to look unaesthetic !  Organise your displays with
  1271.         some thought of this in mind.
  1272.  
  1273.         IMPORTANT
  1274.  
  1275.         When deciding on the location of Menus you count the top of the
  1276.         screen as the first line immediately below the Information Box!
  1277.  
  1278.  
  1279.  
  1280.  
  1281.  
  1282.  
  1283.  
  1284.  
  1285.  
  1286.  
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.  
  1299.  
  1300.  
  1301.  
  1302.  
  1303.  
  1304.  
  1305.  
  1306.  
  1307.  
  1308.  
  1309.    PcMenu Version 3.0 User Manual                                     Page 21
  1310.  
  1311.    The PalDef Colour Program
  1312.  
  1313.    How To Colour Your Menus
  1314.  
  1315.         You colour your menus with the PalDef Utility.  This utility will
  1316.         let you define up to fifty extra palettes.  Palette 0 is 'Hard
  1317.         Wired' into the program and cannot be changed.  This is the default
  1318.         palette you get when no palette number is specified.
  1319.  
  1320.         To define a palette with the Paldef utility, simply move the bar
  1321.         onto the palette number you wish to define.  To the right you can
  1322.         see the current definition for that palette in the Current Palette
  1323.         Definition Menu.  The colour it displays is the existing colour
  1324.         definition for this palette.  To change the definition, press the
  1325.         Enter key ( or click twice with the left mouse button when the
  1326.         pointer is over the palette you wish to change ).  You will then be
  1327.         asked whether you would like to change the Menu foreground or
  1328.         background colour or whether you want to change the colour of the
  1329.         select bar.  By selecting either foreground or background and
  1330.         pressing the Enter key you will be presented with a list of valid
  1331.         colours for that option.  Simply select the colour you want and hit
  1332.         the return key.  The Example Menu then reflects the choice you have
  1333.         made.  If you are satisfied with your changes simply press the
  1334.         Escape key to exit out of the menus.  ( If you are using the mouse
  1335.         you can exit the active menu by placing the mouse pointer over it
  1336.         and clicking once with the right button.  )
  1337.  
  1338.         To save your palette definitions simply press the Escape key from
  1339.         the Palette list Menu and you will be prompted as to whether you
  1340.         would like to save your changes or abandon them.
  1341.  
  1342.    NOTE
  1343.         The PalDef Utility looks for the file containing the palette colour
  1344.         information called PCMU$PAL.DAT in the current directory.  If a
  1345.         directory has been assigned to the 'palette' option in the ini file
  1346.         then it will look in the directory specified by this variable
  1347.         unless the DOS environment variable PCMENU_PALETTE is defined, in
  1348.         which case it will look there!  ( DOS Environment Variables
  1349.         override the values specified in the 'ini' file.  )
  1350.  
  1351.          See the section titled 'Installation of PcMenu' for more
  1352.         information.
  1353.  
  1354.         If the file PCMU$PAL.DAT does not exist, PcMenu will create the
  1355.         file when loaded for the first time ( as will the PalDef Utility ). 
  1356.         In this case, all palettes, except palette 0 will be Black print on
  1357.         a White background.  ( This enables users of monochrome screens to
  1358.         set up a colour scheme that works!! )
  1359.  
  1360.  
  1361.  
  1362.  
  1363.  
  1364.    PcMenu Version 3.0 User Manual                                     Page 22
  1365.  
  1366.     ┌───────────────────────────────────────────────────────────────────────┐
  1367.     │ PalDef Ver 3.0   Copyright (c) 1989-93 Brian Habel ALL RIGHTS RESERVED│
  1368.     └───────────────────────────────────────────────────────────────────────┘
  1369.                                                         ╔═══════════════════╗
  1370.     ╔═══════════════╗  ╔═════════════════════════════╗  ║ Foreground Colours║
  1371.     ║   Palettes    ║  ║  Colour Selection For Menu  ║  ╠═══════════════════╣
  1372.     ╠═══════════════╣  ╠═════════════════════════════╣  ║ │ Black           ║
  1373.     ║ │ Palette 1   ║  ║ │  Menu   Foreground        ║  ║ │ Blue            ║
  1374.     ║ │ Palette 2   ║  ║ │  Menu   Background        ║  ║ │ Green           ║
  1375.     ║ │ Palette 3   ║  ║ │  Menu   Select Bar        ║  ║ │ Cyan            ║
  1376.     ║ │ Palette 4   ║  ╚═════════════════════════════╝  ║ │ Red             ║
  1377.     ║ │ Palette 5   ║                                   ║ │ Magenta         ║
  1378.     ║ │ Palette 6   ║                                   ║ │ Brown           ║
  1379.     ║ │ Palette 7   ║                                   ║ │ White           ║
  1380.     ║ │ Palette 8   ║                                   ║ │ Dark Grey       ║
  1381.     ║ │ Palette 9   ║                                   ║ │ Light Blue      ║
  1382.     ║ │ Palette 10  ║ ╔══════════════════════════════╗  ║ │ Light Green     ║
  1383.     ║ │ Palette 11  ║ ║  Current Palette Definition  ║  ║ │ Light Cyan      ║
  1384.     ║ │ Palette 12  ║ ╠══════════════════════════════╣  ║ │ Light Red       ║
  1385.     ║ │ Palette 13  ║ ║ │     Option One             ║  ║ │ Light Magenta   ║
  1386.     ║ │ Palette 14  ║ ║ │     Option Selected        ║  ║ │ Light Yellow    ║
  1387.     ║ │ Palette 15  ║ ║ │     Option Three           ║  ║ │ Bright White    ║
  1388.     ╚═══════════════╝ ╚══════════════════════════════╝  ╚═══════════════════╝
  1389.  
  1390.     <Esc> Exit Window    Choose Item  ┘ Select Item Mon Aug 23,1993 12:14:15
  1391.  
  1392.                      Fig.  3 Screen Layout of the Paldef Utility
  1393.  
  1394.  
  1395.  
  1396.  
  1397.  
  1398.  
  1399.  
  1400.  
  1401.  
  1402.  
  1403.  
  1404.  
  1405.  
  1406.  
  1407.  
  1408.  
  1409.  
  1410.  
  1411.  
  1412.  
  1413.  
  1414.  
  1415.  
  1416.  
  1417.  
  1418.  
  1419.    PcMenu Version 3.0 User Manual                                     Page 23
  1420.  
  1421.           Appendix A
  1422.  
  1423.           Compatibility between Version 3.0 and Version 2.1
  1424.  
  1425.           A couple of problems I've noticed between this version and 2.1
  1426.                -    Old PCMU$LOG.DAT files are not compatible with this
  1427.                     version This usually causes PcMenu not to find its
  1428.                     "menu" file.  If this happens, simply delete the 'LOG'
  1429.                     file and try to start the menu system again!
  1430.  
  1431.                -    The INI file can cause confusion at times.  If you want
  1432.                     to use the values in the INITIALISATION file then, to
  1433.                     avoid confusion, make sure that all DOS Environment
  1434.                     Variables, PCMENU_BATCH, PCMENU_TEMP, PCMENU_HEADER,
  1435.                     PCMENU_PALETTE are "Undefined".  You have to use the
  1436.                     DOS Environment Variable PCMENU_INI or the /I option on
  1437.                     the command line to tell PcMenu ( and PalDef ) the
  1438.                     DIRECTORY to look for the INI file.
  1439.  
  1440.           A list of all the changes made to this version and those not
  1441.           found in this documentation are found in the file HISTORY.TXT.
  1442.  
  1443.  
  1444.  
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.  
  1451.  
  1452.  
  1453.  
  1454.  
  1455.  
  1456.  
  1457.  
  1458.  
  1459.  
  1460.  
  1461.  
  1462.  
  1463.  
  1464.  
  1465.  
  1466.  
  1467.  
  1468.  
  1469.  
  1470.  
  1471.  
  1472.  
  1473.  
  1474.    PcMenu Version 3.0 User Manual                                     Page 24
  1475.  
  1476.           Appendix B
  1477.  
  1478.           Amendments and Additions to PcMenu Version 2.1
  1479.  
  1480.           A lot of the changes to PcMenu Version 3.0 have culminated from
  1481.           those people who responded to my initial release of PcMenu
  1482.  
  1483.           To those people, Many thanks ! ( And now for your reward )
  1484.  
  1485.           Changes/Additions in this version include
  1486.  
  1487.                ∙    An initialisation file ( called PCMU$INI.DAT ) as an
  1488.                     alternative to using valuable DOS environment space. 
  1489.                     See the example file included with this release, it
  1490.                     should be self explanatory !
  1491.  
  1492.                ∙    Periodic update of the information Box.  Whenever a
  1493.                     change is made to the file PCMU$HDR.DAT, PcMenu will
  1494.                     detect the change ( by use of the DOS file time stamp
  1495.                     ),  reload and display the contents of the file.  So,
  1496.                     even if PcMenu is running passively, the Information
  1497.                     Box will be updated immediately.  It will also
  1498.                     re-display the screen if the screen is blanked.
  1499.  
  1500.                ∙    Dos Environment expansion now works correctly for Menu
  1501.                     Titles !
  1502.  
  1503.                ∙    Alt-F10 "Exit to DOS" key sequence has been added. 
  1504.                     Allowing for immediate exit to DOS regardless of what
  1505.                     menu is displayed !
  1506.  
  1507.                ∙    Alpha Keying has been added !
  1508.  
  1509.                ∙    The Novell's " !logout " command now works !
  1510.  
  1511.                ∙    Display location problems have been fixed.  Menu
  1512.                     shadow's no longer wrap around as they incorrectly did
  1513.                     previously.
  1514.  
  1515.                ∙    Menu option wrap around has been removed in this
  1516.                     Version as it truly was unrealistic !
  1517.  
  1518.                ∙    Type ahead buffers are no longer flushed !
  1519.  
  1520.                ∙    Improvements have been made to the error reporting
  1521.                     code.
  1522.  
  1523.  
  1524.  
  1525.  
  1526.  
  1527.  
  1528.  
  1529.    PcMenu Version 3.0 User Manual                                     Page 25
  1530.  
  1531.                ∙    PcMenu now cleans up the batch files it creates.
  1532.                     Users of DOS 3.20 may see superfluous batch file code
  1533.                     as they ESCape from PcMenu.  Later DOS versions appear
  1534.                     to behave as intended.
  1535.  
  1536.                ∙    A bug in the Date and Time display has been fixed.
  1537.  
  1538.                ∙    External file Sub Menu bug has been fixed.
  1539.                     Sub menus from external files did not load correctly
  1540.                     under certain circumstances.
  1541.  
  1542.                ∙    Buffer overruns, that sometimes occurred when the last
  1543.                     line in menu scripts are not terminated with a RETURN
  1544.                     character have been fixed.
  1545.  
  1546.                ∙    The screen saver now optionally displays a simple
  1547.                     message across the bottom of the screen.  This is to
  1548.                     differentiate between a computer    that has been
  1549.                     switched off and one running this screen saver !
  1550.  
  1551.                ∙    It was felt that when Information Box colours were
  1552.                     changed, that the help bar colours clashed !  The
  1553.                     option has now been added to the PCMU$INI.DAT file so
  1554.                     that when global colours are set for the Information
  1555.                     Box they also apply to the help bar as well.
  1556.  
  1557.                ∙    Added clipping to the PCMU$HDR file.  The file can only
  1558.                     contain 14 lines of information ( excluding global
  1559.                     colour info if present ).
  1560.  
  1561.                ∙    Added the 'Option Hiding' Feature !
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.  
  1569.  
  1570.  
  1571.  
  1572.  
  1573.  
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581.  
  1582.  
  1583.  
  1584.    PcMenu Version 3.0 User Manual                                     Page 26
  1585.  
  1586.           Appendix C
  1587.  
  1588.           The format of the initialisation file & use with NetWare
  1589.  
  1590.           This example is configured for use in the Novell NetWare
  1591.           environment.  The PcMenu files are held in the sub-directory
  1592.           M:\APPS\PCMENU.  This allows BOTH PcMenu and Novell's original
  1593.           Menu program to be used on the same network.  The program runs
  1594.           from the BATch file PCMENU.BAT ( see below ), as opposed to
  1595.           PcMenu's default MENU.BAT, to avoid conflicting with Novell's
  1596.           MENU program.  Add ROS rights to the group EVERYONE for this new
  1597.           directory.  PCMENU.BAT should be copied to a mapped search
  1598.           directory, eg SYS:PUBLIC
  1599.  
  1600.           Add to the system login script
  1601.  
  1602.           DOS SET STN="%STATION"
  1603.           DOS SET MENU="MENU.MNU"  If this is set the command PCMENU.BAT on
  1604.                                    its own will run this default menu.
  1605.           DOS SET NAME="%LOGIN_NAME"
  1606.  
  1607.           PCMENU.BAT
  1608.           echo off
  1609.           rem Some Displays get their current mode mucked up !
  1610.           rem Reset it back to text mode
  1611.           rem mode co80
  1612.           rem Start up PcMenu
  1613.           set pcmenu_ini=F:\APPS\PCMENU
  1614.           cd M:\apps\pcmenu
  1615.           M:
  1616.           rem use parameter as menu name otherwise use variable %MENU%
  1617.           pcmenu %1 %2 %3 %MENU%
  1618.           cd M:\apps
  1619.           H:
  1620.           if errorlevel 1 goto exit
  1621.           rem Use the %STN% variable or, if the same person logged into the
  1622.           network
  1623.           rem twice, the menu wouldn't know which one to run!
  1624.           H:\USERS\%NAME%\pcmu$%STN%.bat
  1625.           :exit
  1626.           cd f:\apps
  1627.           H:
  1628.  
  1629.  
  1630.  
  1631.  
  1632.  
  1633.  
  1634.  
  1635.  
  1636.  
  1637.  
  1638.  
  1639.    PcMenu Version 3.0 User Manual                                     Page 27
  1640.  
  1641.    PCMU$INI.DAT
  1642.    #
  1643.    #  PcMenu Version 3.0.x  Initialisation file.
  1644.    #  PalDef Version 3.0.x  also uses this file to locate Palette data file.
  1645.    #
  1646.    #  You can specify the directory where this file can be found using the
  1647.    #  /I option on the command line ( again with both PcMenu and PalDef )
  1648.    #
  1649.    #  Alternatively, both these programs use the NEW Dos Environment Variable
  1650.    #  PCMENU_INI when set to the directory containing this file.  ( Which will
  1651.    #  override the /I option )
  1652.    #
  1653.    #  DOS ENVIRONMENT VARIABLES ALWAYS OVERRIDE THE VALUES IN THIS FILE !
  1654.    #
  1655.    #  As you have probably gathered by now the '#' character is a comment !
  1656.    #
  1657.    #  This file consists of 'parameters' = 'value'
  1658.    #
  1659.    #  'value' 's can include values from DOS ENV by surrounding the
  1660.    #   DOS Environment Variable name in < > characters.
  1661.    #
  1662.    # PALETTE  specifies the directory in which the file PCMU$PAL.DAT
  1663.    #          DOS environment variable PCMENU_PALETTE will override this
  1664.    #          value.
  1665.    #
  1666.    palette  = M:\APPS\PCMENU
  1667.    #
  1668.    #
  1669.    # HEADER   specifies the directory in which the file PCMU$HDR.DAT
  1670.    #          DOS environment variable PCMENU_HEADER will override this
  1671.    #          value.
  1672.    #
  1673.    header   = M:\APPS\PCMENU
  1674.    #
  1675.    #
  1676.    # BATCH    specifies the DIRECTORY that you want the file PCMU$BAT.BAT
  1677.    #          to be created.  This directory must be read/writable.
  1678.    #          DOS environment variable PCMENU_BATCH will override this
  1679.    #          value.
  1680.    #
  1681.    #          **Note the value placed here must also be placed in MENU.BAT**
  1682.    #          ( or whatever you are using to control the menu system )
  1683.    #
  1684.    #
  1685.    batch = H:\USERS\<NAME>
  1686.    #
  1687.    #
  1688.    #
  1689.    #
  1690.    # TEMP     specifies the directory that PcMenu uses for its scratch files.
  1691.    #          This directory must be read/writable.
  1692.    #          DOS environment variable PCMENU_TEMP will override this
  1693.  
  1694.     PcMenu Version 3.0 User Manual                                     Page 28
  1695.  
  1696.    #          value.
  1697.    #
  1698.    temp  = H:\USERS\<NAME>
  1699.    #
  1700.    #
  1701.    # MENU_BATCH   specifies the path and name of the controlling Batch file
  1702.    #              ( or whatever ) that is used to reload PcMenu after
  1703.    #              command launch.  ( Default: MENU.BAT )
  1704.    #
  1705.    menu_batch  = PCMENU.BAT
  1706.    #
  1707.    #
  1708.    # BATCH_FILENAME  specifies the name of the batch file that PcMenu creates
  1709.    #                 in the directory specified by the 'batch' parameter or
  1710.    #                 the PCMENU_BATCH Dos Environment Variable.
  1711.    #                 ( Default: PCMU$BAT.BAT )
  1712.    #
  1713.    #          **Note the value placed here must also be placed in MENU.BAT**
  1714.    #          ( or whatever you are using to control the menu system )
  1715.    #
  1716.    batch_filename = PCMU$<STN>.BAT
  1717.    #
  1718.    # INFO_BOX_UPDATE  where the 'value' is set to the number of seconds that
  1719.    #                  you want PcMenu to check the PCMU$HDR.DAT file for
  1720.    #                  modification.
  1721.    #
  1722.    #             ( Warning - Small Values may put heavy loads on File Servers )
  1723.    #
  1724.    #                  if 'value' is set to 0 timed updating is not used,
  1725.    #                  and PcMenu only loads the Information Box on initial
  1726.    #                  startup and when returning from DOS after an executed
  1727.    #                  menu option !    ( Default: 0 )
  1728.    #
  1729.    info_box_update = 100
  1730.    #
  1731.    #
  1732.    # SCREEN_SAVER    where 'value' is set to the time of inactivity until
  1733.    #                 the screen saver is activated.
  1734.    #
  1735.    #                 If set to ZERO the screen saver is disabled !
  1736.    #
  1737.    screen_saver = 300
  1738.    #
  1739.    #
  1740.    # ALPHA_KEYING   Specifies whether you want alpha keying enabled !
  1741.    #                set 'value' to 'on'  for enabled
  1742.    #                            or 'off' for disabled ( Default )
  1743.    #
  1744.    alpha_keying = on
  1745.    #
  1746.    #
  1747.  
  1748.     PcMenu Version 3.0 User Manual                                     Page 29
  1749.  
  1750.    # TABS    selects tabulation points used in formatting Menu layouts.
  1751.    #         Measured from the left edge of the window, each successive
  1752.    #         TAB character found will start the cursor at the next tab
  1753.    #         position.
  1754.    #
  1755.    #         'value' is specified by a series of tab positions in increasing
  1756.    #         order, separated by commas.
  1757.    #
  1758.    #         Tab positions are used in 'Menu Titles' and 'Menu Options' Only.
  1759.    #         There is no default value for this parameter so if this option
  1760.    #         is not specified or the tabulation list is exhausted successive
  1761.    #         TAB characters will be ignored.
  1762.    #
  1763.    Tabs = 8,16,24,32
  1764.    #
  1765.    # HELP_BAR_COLOURS    Define the colours of the help bar by using global
  1766.    #                    colours from Information Box Details.
  1767.    #
  1768.    #       'value' of 'default' is the default value for this option.
  1769.    #
  1770.    #        set 'value' to 'default' to always retain system Default settings
  1771.    #        or 'infobox' to have colours follow GLOBAL colour
  1772.    #        settings in the PCMU$HDR.DAT file
  1773.    #
  1774.    help_bar_colours = infobox
  1775.    #
  1776.    #
  1777.    # SAVER_MESSAGES  Enables or Disables ALL Screen Saver Messages
  1778.    #
  1779.    #             set 'value' to 'on' to enable default saver messages, and
  1780.    #                         the 'screen_saver_message' if set.  ( Default )
  1781.    #
  1782.    #                         to 'off' for NO messages.  The screen remains
  1783.    #                         blank.
  1784.    #
  1785.    saver_messages = on
  1786.    #
  1787.    #
  1788.    # SCREEN_SAVER_MESSAGE  Display your own message while screen saver Active.
  1789.    #
  1790.    #                  This adds to the default list of screen saver messages
  1791.    #                  a user defined string "value" that will display
  1792.    #                  every THIRD time.  ( ie.  after the two default messages )
  1793.    #
  1794.    #                  Text MUST be enclosed in quotes and can be <= 80 chars !
  1795.    #
  1796.    screen_saver_message= "PcMenu V3.0  now has MORE features to offer !"
  1797.    #
  1798.  
  1799.    PcMenu Version 3.0 User Manual                                     Page 30
  1800.  
  1801.  
  1802.           Appendix D
  1803.  
  1804.           Registration Form
  1805.  
  1806.           Although you are not obliged to register, by doing so you will be
  1807.           notified of any further updates to PcMenu if and when released.
  1808.  
  1809.           Name:_____________________________________________________________
  1810.  
  1811.           Organisation:_____________________________________________________
  1812.  
  1813.           Postal Address:___________________________________________________
  1814.  
  1815.                                                                            
  1816.  
  1817.                                                                            
  1818.  
  1819.           City:__________________________    Zip/Post Code:_________________
  1820.  
  1821.           State:_________________________     Country:______________________
  1822.  
  1823.           Email Address ( If you have internet access ):____________________
  1824.  
  1825.           Where is this software being used ?       o  Personal PC   
  1826.  
  1827.             o  Education/Training          o  Comercial Business
  1828.  
  1829.             o  Government Dept.            Other:___________________________
  1830.  
  1831.  
  1832.           What Network are you using ?    o  Netware   o  Banyan    o  3Com
  1833.  
  1834.           o  Lantastic            Other:____________________________________
  1835.  
  1836.  
  1837.           Comment:__________________________________________________________
  1838.  
  1839.           __________________________________________________________________
  1840.  
  1841.           __________________________________________________________________
  1842.  
  1843.           __________________________________________________________________
  1844.  
  1845.  
  1846.  
  1847.    PcMenu Version 3.0 User Manual                                     Page 31
  1848.